home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / DTMLDOCUMENT.PY < prev    next >
Encoding:
Text File  |  2000-10-31  |  8.0 KB  |  206 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86.  
  87. def manage_addDocument(id, title):
  88.     """
  89.     Add a DTML Document to the current ObjectManager
  90.     """
  91.  
  92.  
  93. class DTMLDocument:
  94.     """
  95.     A DTML Document is a Zope object that contains and executes DTML
  96.     code. It is useful to represent web pages.
  97.     """
  98.     
  99.     __extends__=(
  100.         'OFSP.ObjectManagerItem.ObjectManagerItem',
  101.         'OFSP.PropertyManager.PropertyManager',
  102.         )
  103.     
  104.     def __call__(client=None, REQUEST={}, RESPONSE=None, **kw):
  105.         """
  106.  
  107.         Calling a DTMLDocument causes the Document to interpret the DTML
  108.         code that it contains.  The method returns the result of the
  109.         interpretation, which can be any kind of object.
  110.  
  111.         To accomplish its task, DTML Document often needs to resolve various
  112.         names into objects.  For example, when the code '<dtml-var
  113.         spam>' is executed, the DTML engine tries to resolve the name
  114.         'spam'.
  115.  
  116.         In order to resolve names, the Document must be passed a
  117.         namespace to look them up in.  This can be done several ways:
  118.  
  119.           * By passing a 'client' object -- If the argument 'client' is
  120.             passed, then names are looked up as attributes on the
  121.             argument.
  122.  
  123.           * By passing a 'REQUEST' mapping -- If the argument 'REQUEST'
  124.             is passed, then names are looked up as items on the
  125.             argument.  If the object is not a mapping, an TypeError
  126.             will be raised when a name lookup is attempted.
  127.  
  128.           * By passing keyword arguments -- names and their values can
  129.             be passed as keyword arguments to the Document.
  130.  
  131.         The namespace given to a DTML Document is the composite of
  132.         these three methods.  You can pass any number of them or none
  133.         at all. Names are looked up first in the keyword arguments,
  134.         then in the client, and finally in the mapping.
  135.  
  136.         A DTMLDocument implicitly pass itself as a client argument in
  137.         addition to the specified client, so names are looked up in
  138.         the DTMLDocument itself.
  139.  
  140.         Passing in a namespace to a DTML Document is often referred to
  141.         as providing the Document with a *context*.
  142.  
  143.         DTML Documents are called three ways:
  144.  
  145.           From DTML -- A DTML Document can be called from another DTML
  146.             Method or Document::
  147.  
  148.               <dtml-var standard_html_header>
  149.                 <dtml-var aDTMLDocument>
  150.               <dtml-var standard_html_footer>
  151.  
  152.             In this example, the Document 'aDTMLDocument' is being called
  153.             from another DTML object by name.  The calling method
  154.             passes the value 'this' as the client argument and the
  155.             current DTML names pace as the REQUEST argument.  The above
  156.             is identical to this following usage in a DTML Python
  157.             expression::
  158.  
  159.               <dtml-var standard_html_header>
  160.                 <dtml-var "aDTMLDocument(_.None, _)">
  161.               <dtml-var standard_html_footer>
  162.  
  163.           From Python -- Products, External Methods, and PythonMethods 
  164.             can call a DTML Document in the same way as calling a DTML
  165.             Document from a Python expression in DTML; as shown in the
  166.             previous example.
  167.  
  168.           By the Publisher -- When the URL of a DTML Document is fetched 
  169.             from Zope, the DTML Document is called by the publisher.
  170.             The REQUEST object is passes as the second argument to the 
  171.             Document.  
  172.           
  173.         Permission -- 'View'
  174.  
  175.         """
  176.  
  177.     def manage_edit(data, title):
  178.         """
  179.         Change the DTML Document, replacing its contents with 'data'
  180.         and
  181.         changing its title.
  182.         
  183.         The data argument may be a file object or a string.
  184.         
  185.         Permission -- 'Change DTML Documents'
  186.         """
  187.         
  188.     def document_src():
  189.         """
  190.         Returns the unrendered source text of the DTML Document.
  191.         
  192.         Permission -- 'View management screens'
  193.         """
  194.         
  195.     def get_size():
  196.         """
  197.         Returns the size of the unrendered source text of the DTML
  198.         Document in bytes.
  199.  
  200.         Permission -- 'View'
  201.         """
  202.  
  203.     __constructor__=manage_addDocument
  204.  
  205.  
  206.